-
Notifications
You must be signed in to change notification settings - Fork 6.5k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
net: wifi: Add API docs #59859
net: wifi: Add API docs #59859
Conversation
54c03de
to
c72ff04
Compare
c72ff04
to
eb2d383
Compare
eb2d383
to
6cd8515
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Overall looks good, just one question.
Support for legacy types has been added primarily to identify in scan results. Signed-off-by: Chaitanya Tata <Chaitanya.Tata@nordicsemi.no>
Fix doxygen formatting and add comments. Signed-off-by: Chaitanya Tata <Chaitanya.Tata@nordicsemi.no>
Add Wi-Fi management docs and APIs. Signed-off-by: Chaitanya Tata <Chaitanya.Tata@nordicsemi.no>
6cd8515
to
5dbc870
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I realize this has been merged already, but somehow I missed the chance to review in time. Any chance you could address in a follow up PR? @krish2718
/* TWT setup operation */ | ||
WIFI_TWT_SETUP = 0, | ||
/* TWT teardown operation */ | ||
WIFI_TWT_TEARDOWN, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing javadoc style comment
/* TWT individual negotiation */ | ||
WIFI_TWT_INDIVIDUAL = 0, | ||
/* TWT broadcast negotiation */ | ||
WIFI_TWT_BROADCAST, | ||
/* TWT wake TBTT negotiation */ | ||
WIFI_TWT_WAKE_TBTT |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing javadoc style comment
enum wifi_twt_setup_cmd { | ||
/* TWT Requests */ | ||
/** TWT Requests */ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Use
/**
* @name TWT requests
* @{
To actually create a proper group
WIFI_TWT_SETUP_CMD_DEMAND, | ||
/* TWT Responses */ | ||
/** TWT Responses */ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Group with name
/* TWT setup request */ | ||
WIFI_TWT_SETUP_CMD_REQUEST = 0, | ||
/* TWT setup suggest (parameters can be changed by AP) */ | ||
WIFI_TWT_SETUP_CMD_SUGGEST, | ||
/* TWT setup demand (parameters can not be changed by AP) */ |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing javadoc style comments
/* TWT setup grouping (grouping of TWT flows) */ | ||
WIFI_TWT_SETUP_CMD_GROUPING, | ||
/* TWT setup accept (parameters accepted by AP) */ | ||
WIFI_TWT_SETUP_CMD_ACCEPT, | ||
/* TWT setup alternate (alternate parameters suggested by AP) */ | ||
WIFI_TWT_SETUP_CMD_ALTERNATE, | ||
/* TWT setup dictate (parameters dictated by AP) */ | ||
WIFI_TWT_SETUP_CMD_DICTATE, | ||
/* TWT setup reject (parameters rejected by AP) */ | ||
WIFI_TWT_SETUP_CMD_REJECT, |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Missing javadoc style comment
Raised: #60406 |
Add a basic API docs, this can be extended to add detailed sections and details in future PRs.
Based on #59249 as that has few structure changes.